home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilMemoryImg.z / ilMemoryImg
Encoding:
Text File  |  2002-10-03  |  11.8 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg - image array resident in memory
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilMemoryImg.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This class provides a simple way to access a contiguous array of data
  19.      through the IL. It can be used as an external interface between the IL
  20.      and other libraries or devices. It can also be used as the base class to
  21.      derive classes supporting such external devices or libraries.
  22.  
  23.      An ilMemoryImg can be created on top of an existing array allocated by
  24.      the user.  If no array is given, then one is allocated based on the size
  25.      specified by the user.  In either case, the IL expects the entire image
  26.      to reside in the array.  Once the ilMemoryImg is created, it can be used
  27.      just like any other IL image object.  In addition, the user can get a
  28.      pointer to the array, so that it can be read from or written to as
  29.      needed.  In this way, an ilMemoryImg can be used to import external data
  30.      to the IL or export data from the IL.  ilMemoryImg can also be used to
  31.      hold temporary rapid access copies of images when necessary.  Various
  32.      functions such as sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((()))) and sssseeeettttCCCCoooooooorrrrddddSSSSppppaaaacccceeee(((()))) can be used to
  33.      alter the interpretation of the data.
  34.  
  35.      The inherited member functions, ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((()))), sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((()))), and
  36.      ccccooooppppyyyyTTTTiiiilllleeee3333DDDD(((()))) are implemented to access the data array.  The inherited
  37.      member function, ffffiiiillllllllTTTTiiiilllleeee3333DDDD(((()))), is implemented to fill a tile with the
  38.      fill pixel.
  39.  
  40. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  41.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  42.  
  43.           ilMemoryImg(const iflSize& size, iflDataType type,
  44.                       iflOrder order=iflInterleaved)
  45.           ilMemoryImg(void* data, const iflSize& size, iflDataType type,
  46.                       iflOrder order=iflInterleaved)
  47.           ilMemoryImg(ilImage* img)
  48.  
  49.      DDDDiiiirrrreeeecccctttt aaaacccccccceeeessssssss
  50.  
  51.           void* getDataPtr()
  52.           void setDataPtr(void* data)
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.      SSSSyyyynnnncccchhhhrrrroooonnnniiiizzzzaaaattttiiiioooonnnn
  75.  
  76.           void markDirty()
  77.           void sync()
  78.  
  79.  
  80. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  81.      iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg(((())))
  82.  
  83.           ilMemoryImg(const iflSize& size, iflDataType type,
  84.                       iflOrder order=iflInterleaved)
  85.           ilMemoryImg(void* data, const iflSize& size, iflDataType type,
  86.                       iflOrder order=iflInterleaved)
  87.           ilMemoryImg(ilImage* img)
  88.  
  89.  
  90.           The first constructor allocates an array to hold data of _s_i_z_e pixels
  91.           with data type, _t_y_p_e, and dimension ordering, _o_r_d_e_r.  This data is
  92.           deallocated when the object is destroyed.
  93.  
  94.           The second constructor uses the array indicated by _d_a_t_a to hold the
  95.           pixels. Management of this array is left to the user.
  96.  
  97.           The third constructor takes a pointer to an ilImage. Image
  98.           attributes are inherited from this input image.
  99.  
  100.      ggggeeeettttDDDDaaaattttaaaaPPPPttttrrrr(((())))
  101.  
  102.           void* getDataPtr()
  103.  
  104.  
  105.           This function returns a pointer to the internal image data array.
  106.           This can be used to interface directly to other libraries or
  107.           external devices that dump their data into CPU memory.
  108.  
  109.      mmmmaaaarrrrkkkkDDDDiiiirrrrttttyyyy(((())))
  110.  
  111.           void markDirty()
  112.  
  113.  
  114.           This function indicates that the data content or some other
  115.           attribute has changed by setting the altered flag. This causes a
  116.           reset to propagate down the chain.
  117.  
  118.      sssseeeettttDDDDaaaattttaaaaPPPPttttrrrr(((())))
  119.  
  120.           void setDataPtr(void* data)
  121.  
  122.  
  123.           This function sets the pointer to the internal image data array.
  124.           This can be used to interface directly to other libraries or
  125.           external devices that dump their data into CPU memory.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.      ssssyyyynnnncccc(((())))
  141.  
  142.           void sync()
  143.  
  144.  
  145.           This function synchronizes attributes and data to the input image.
  146.           If the ilMemoryImg is not constructed from an ilImage, this function
  147.           has no affect.
  148.  
  149. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  150.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  151.      addInput(), allocFillData(), checkColorModel(), checkValidOrder(),
  152.      checkValidType(), clipTile(), configureRetainedCache(), copy(),
  153.      copyTile(), copyTile3D(), copyTileCfg(), fillTile(), fillTile3D(),
  154.      fillTileRGB(), freeFillData(), getColorImg(), getColorModel(),
  155.      getColormap(), getCompression(), getConfig(), getCopyConverter(),
  156.      getCsize(), getDataType(), getDimensions(), getDirectInput(),
  157.      getDisplayCacheEnable(), getFill(), getFillData(), getFillValue(),
  158.      getHeight(), getHwEnable(), getHwHint(), getHwIntHint(), getHwOp(),
  159.      getHwPassTable(), getInput(), getInputTileRequirement(),
  160.      getLockTileSet(), getMaxColormapLevels(), getMaxValue(), getMinValue(),
  161.      getNumChans(), getNumInputs(), getOrder(), getOrientation(),
  162.      getPageBorder(), getPageBorderX(), getPageBorderY(), getPageBorderZ(),
  163.      getPageCounts(), getPageDelta(), getPageDimensions(), getPageIndices(),
  164.      getPageOrigin(), getPageOriginC(), getPageOriginX(), getPageOriginY(),
  165.      getPageOriginZ(), getPageSize(), getPageSizeC(), getPageSizePix(),
  166.      getPageSizeVal(), getPageSizeX(), getPageSizeY(), getPageSizeZ(),
  167.      getPixel(), getPixel3D(), getPriority(), getScaleMax(), getScaleMin(),
  168.      getSize(), getStrides(), getSubTile(), getSubTile3D(), getTile(),
  169.      getTile3D(), getWidth(), getXsize(), getYsize(), getZsize(),
  170.      hasPageBorder(), hasPages(), hwDefine(), hwGetPass(), inherit(),
  171.      initColorModel(), initHwEnable(), initMinMax(), initPageSize(),
  172.      initScaleMinMax(), isColorImg(), isIntegral(), isMirrorOrientation(),
  173.      isPartialPage(), isSigned(), isValidPage(), isWritable(), lockPage(),
  174.      lockPageSet(), lockTile(), lockTile3D(), mapFlipTrans(), mapFromInput(),
  175.      mapFromSource(), mapOrientation(), mapSize(), mapTile(), mapToInput(),
  176.      mapToSource(), mapXY(), mapXYSign(), outOfBound(), qCopyTileCfg(),
  177.      qFillTile3D(), qFillTileRGB(), qGetSubTile3D(), qGetTile3D(),
  178.      qLockPageSet(), qSetSubTile3D(), qSetTile3D(), removeHwHint(),
  179.      removeInput(), reset(), setColorModel(), setColormap(), setCompression(),
  180.      setCsize(), setDataType(), setDisplayCacheEnable(), setFill(),
  181.      setFillValue(), setHwEnable(), setHwHint(), setHwIntHint(), setInput(),
  182.      setMaxColormapLevels(), setMaxValue(), setMinValue(), setNumChans(),
  183.      setNumInputs(), setOrder(), setOrientation(), setPageBorder(),
  184.      setPageSize(), setPageSizeC(), setPageSizeZ(), setPixel(), setPixel3D(),
  185.      setPriority(), setScaleMinMax(), setScaleType(), setSize(), setSubTile(),
  186.      setSubTile3D(), setTile(), setTile3D(), setTileRequirementFunction(),
  187.      setWritable(), setXsize(), setYsize(), setZsize(), unlockPage(),
  188.      unlockPageSet()
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllMMMMeeeemmmmoooorrrryyyyIIIImmmmgggg((((3333))))
  203.  
  204.  
  205.  
  206.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  207.      addResetCallback(), alterAction(), anyAltered(), clearAllowed(),
  208.      clearSet(), clearStatus(), deleteRelated(), disableAltered(),
  209.      dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
  210.      getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
  211.      getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
  212.      getParent(), getProp(), getProp(), getPropSet(), getPtrProp(),
  213.      getRelatedChild(), getRelatedDelete(), getRelatedType(), getStatus(),
  214.      hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
  215.      isAltered(), isEnabled(), isRelated(), isSet(), markSet(), mpUnlock(),
  216.      neverReset(), newRelatedType(), removeParent(), removeProp(),
  217.      removeResetCallback(), reset(), resetAltered(), resetCheck(),
  218.      setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
  219.      setEnabled(), setParent(), setProp(), setPropAltered(),
  220.      setRelatedDelete(), setRelatedType(), setStatus(), stopWatching(),
  221.      unalterable(), watch(), watchNotify()
  222.  
  223. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  224.      ilImage
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.